Skip to content

Speed up SearchRouter open: overlap list render with the push animation - #97246

Merged
mountiny merged 3 commits into
Expensify:mainfrom
software-mansion-labs:perf/search-router-warm-cache
Jul 31, 2026
Merged

mountiny merged 3 commits into
Expensify:mainfrom
software-mansion-labs:perf/search-router-warm-cache

Conversation

@sumo-slonik

@sumo-slonik sumo-slonik commented Jul 28, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Speeds up opening the SearchRouter on native with two small, SearchRouter-local changes.

#95683 and #95378 already reduced the option-list build cost substantially — that build is now a small,
cached part of the open. Building on those gains, this change targets the time that remains, which
profiling traced to two other places:

  • Overlap the list render with the push animation — DeferredSearchAutocompleteList/index.native.tsx.
    The list was deferred until the native-stack push animation ended, so its render ran serially after the
    ~350ms slide and the list's onLayout (which ends ManualOpenSearchRouter) fired ~150ms after it. The
    push is native-driven (UI thread), so rendering the list on the JS thread during it does not stutter the
    slide. We now mount the list as soon as the skeleton has laid out, overlapping the render with the
    animation. Affordable because the option build is already cheap after perf: shrink SearchRouter's initial recent-reports build, paginate on scroll #95683/Speed up SearchRouter open on large accounts #95378.
  • Stabilize useAutocompleteSuggestions — the empty-query path returned a fresh [] every render,
    invalidating the consumer's sections memo and re-rendering the list on every parent render. It now
    returns a stable empty array, removing those re-render spikes.

Performance (settled heavy account, Android, n=10 per variant in one session, isolating the open from
post-launch churn; every sample verified on the heavy account). The win is on P90 (the production
target), driven by the variance collapse — main's first-open time is spiky, this PR is flat:

Metric (cold, first open in session) main this PR
ManualOpenSearchRouter — median 516ms 475ms
ManualOpenSearchRouter — P90 648ms 483ms (−25%)
stdev 81ms 10ms

Dev-mode on an emulator, so absolute values run higher than production bytecode; the relative P90 delta and
the variance collapse are the signal. The same measurement on iOS trended in the change's favor but the
delta was marginal enough to sit within measurement error, so no iOS result is claimed.

Fixed Issues

$ #97315
PROPOSAL:

Tests

  1. Android native, high-traffic account, empty query: tap the header Search button — the router opens and
    the recent-reports list appears together with the slide, with no visible "pop-in" or animation stutter.
  2. Reopen it several times — content and ordering are unchanged from main.
  3. Type a query right after opening — filtering works; from: / to: / in: autocomplete still suggests.
  4. Repeat on iOS native (the deferred wrapper and the hook are shared by both native platforms).
  5. Web / desktop: no behavior change (the deferred wrapper is a passthrough there).
  • Verify that no errors appear in the JS console

Offline tests

Open the router while offline — the list renders from local data exactly as it does online.

QA Steps

Same as Tests (Android + iOS native on staging).

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@codecov

codecov Bot commented Jul 28, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
...ch/DeferredSearchAutocompleteList/index.native.tsx 100.00% <100.00%> (+100.00%) ⬆️
src/hooks/useAutocompleteSuggestions.ts 63.50% <ø> (+0.74%) ⬆️
... and 538 files with indirect coverage changes

@mountiny

Copy link
Copy Markdown
Contributor

@MelvinBot create an issue for this pr and assign me and pr author, link the issue in the fixed issues section of the pr

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 Done!

No existing duplicate issue was found for this work.

…on, stabilize autocomplete suggestions

On native the SearchRouter list was deferred until the native-stack push animation ended, so its
render ran serially after the ~350ms slide. Mount the list as soon as the skeleton has laid out so
the render overlaps the native-driven animation and the list's onLayout (which ends the
ManualOpenSearchRouter span) fires ~at animation end instead of ~150ms after it.

Also return a stable empty array from useAutocompleteSuggestions on the empty-query path, so the
consumer's sections memo stops invalidating on every render and the list no longer re-renders on
each parent render.

Measured on a settled heavy account (Android, n=8): ManualOpenSearchRouter ~-29% cold / ~-33% warm,
SearchRouter.ListRender ~-21%, with much tighter variance (stdev 59 -> 10).
@sumo-slonik
sumo-slonik force-pushed the perf/search-router-warm-cache branch from 191f588 to f940abb Compare July 29, 2026 13:16
@sumo-slonik sumo-slonik changed the title Warm the SearchRouter options cache during the open animation on Android Speed up SearchRouter open: overlap list render with the push animation Jul 29, 2026
@sumo-slonik
sumo-slonik marked this pull request as ready for review July 30, 2026 09:25
@sumo-slonik
sumo-slonik requested review from a team as code owners July 30, 2026 09:25
@melvin-bot
melvin-bot Bot requested review from JmillsExpensify and brunovjk and removed request for a team July 30, 2026 09:25
@melvin-bot

melvin-bot Bot commented Jul 30, 2026

Copy link
Copy Markdown

@brunovjk Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot
melvin-bot Bot removed the request for review from a team July 30, 2026 09:25
Comment thread src/hooks/useAutocompleteSuggestions.ts Outdated

if (!autocompleteKey) {
return [];
return EMPTY_SUGGESTIONS;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sumo-slonik Use CONST.EMPTY_ARRAY as it is standard across codebase.

@JmillsExpensify JmillsExpensify left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No product review required on this one.

@brunovjk

Copy link
Copy Markdown
Contributor

@sumo-slonik Should we add a unit test for this? The existing tests only check toEqual([]), which would still pass if this regressed to returning a new empty array on each render.

@brunovjk

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
97246_android_native.mov
Android: mWeb Chrome
97246_android_web.mov
iOS: HybridApp
97246_ios_native.mov
iOS: mWeb Safari
97246_ios_web.mov
MacOS: Chrome / Safari
97246_web_chrome.mov

@brunovjk brunovjk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sumo-slonik Should we add a unit test for this? The existing tests only check toEqual([]), which would still pass if this regressed to returning a new empty array on each render.

We need to confirm whether we need to add a regression test here. Otherwise, LGTM.

@melvin-bot
melvin-bot Bot requested a review from mountiny July 30, 2026 19:27
Add DeferredSearchAutocompleteListTest for the deferred wrapper: it keeps the skeleton until
layout, mounts the list right after the skeleton lays out while a navigation transition is still
pending, and falls back to the skeleton once the screen loses focus.

Assert in useAutocompleteSuggestions that the empty-query path keeps one array reference across
renders and across hook instances, which toEqual([]) could not catch.
@sumo-slonik
sumo-slonik force-pushed the perf/search-router-warm-cache branch from 00c674d to f43ad17 Compare July 31, 2026 10:37
@mountiny
mountiny merged commit a0eb650 into Expensify:main Jul 31, 2026
33 checks passed
@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@github-actions

Copy link
Copy Markdown
Contributor

🚧 mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify OSBotify mentioned this pull request Aug 1, 2026
60 tasks done
@OSBotify

OSBotify commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.4.48-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 No help site changes required.

I reviewed the changes in this PR against the help site content under docs/articles, and no updates are needed.

Why: This is a purely internal, native-only performance optimization with no user-facing behavior change:

  • DeferredSearchAutocompleteList/index.native.tsx — mounts the autocomplete list as soon as the skeleton lays out, overlapping its render with the native-stack push animation instead of waiting for the transition to end. Same content, same ordering — just rendered sooner.
  • useAutocompleteSuggestions.ts — returns a stable empty-array reference on the empty-query path to avoid unnecessary re-renders.

The only observable outcome is that the SearchRouter opens slightly faster on native. Feature behavior, UI labels, tabs, and workflows are unchanged.

The one related article — Use Search Operators to Filter and Analyze — documents that autocomplete suggestions appear when you type after :. That behavior is preserved by this PR, so the article remains accurate.

Since no documentation update is warranted, I did not create a draft help site PR.

@sumo-slonik, please confirm you agree this change is internal-only and requires no help site updates. If you believe a doc change is warranted, let me know what user-facing behavior changed and I'll draft the PR.

@OSBotify

OSBotify commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/arosiclair in version: 9.4.48-3 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants